/**
 * Copyright 2023-present DreamNum Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import type { MentionType } from '../../types/enum';
import type { IMention } from '../../types/interfaces';
import { createIdentifier } from '@wendellhu/redi';

export interface IListMentionParam {
    search?: string;
    type?: MentionType;
    page?: number;
    size?: number;
    unitId?: string;
}

export interface ITypeMentionList {
    mentions: IMention[];
    type: MentionType;
    metadata: Record<string, string>;
    title: string;
}

export interface IListMentionResponse {
    list: ITypeMentionList[];
    page?: number;
    size?: number;
    total?: number;
}

export interface IMentionIOService {
    list (params: IListMentionParam): Promise<IListMentionResponse>;
}

export const IMentionIOService = createIdentifier<IMentionIOService>('univer.service.mention-io');
